package com.che.software.testato.domain.dao;

import java.util.List;

import com.che.software.testato.domain.dao.jdbc.exception.ActivityDocumentationCreationDAOException;
import com.che.software.testato.domain.dao.jdbc.exception.ActivitySearchDAOException;
import com.che.software.testato.domain.entity.Activity;
import com.che.software.testato.domain.entity.ActivityAction;
import com.che.software.testato.domain.entity.ActivityParameter;

/**
 * DAO interface dedicated to the activities management.
 * 
 * @author Clement HELIOU (clement.heliou@che-software.com).
 * @copyright Che Software.
 * @license GNU General Public License.
 * @since July, 2011.
 * 
 *        This file is part of Testato.
 * 
 *        Testato is free software: you can redistribute it and/or modify it
 *        under the terms of the GNU General Public License as published by the
 *        Free Software Foundation, either version 3 of the License, or (at your
 *        option) any later version.
 * 
 *        Testato is distributed in the hope that it will be useful, but WITHOUT
 *        ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *        FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 *        for more details.
 * 
 *        You should have received a copy of the GNU General Public License
 *        along with Testato. If not, see <http://www.gnu.org/licenses/>.
 * 
 *        Testato's logo is a creation of Arrioch
 *        (http://arrioch.deviantart.com/) and it's distributed under the terms
 *        of the Creative Commons License.
 */
public interface IActivityDAO {

	/**
	 * Creates the documentation of an activity from actions and parameters
	 * lists.
	 * 
	 * @author Clement HELIOU (clement.heliou@che-software.com).
	 * @param activity the activity to document.
	 * @param actions the actions list.
	 * @param parameters the parameters list.
	 * @since July, 2011.
	 * @throws ActivityDocumentationCreationDAOException if an error occurs
	 *         during the creation.
	 */
	public void createActivityDocumentation(Activity activity, List<ActivityAction> actions, List<ActivityParameter> parameters) throws ActivityDocumentationCreationDAOException;

	/**
	 * Activities to describe search.
	 * 
	 * @author Clement HELIOU (clement.heliou@che-software.com).
	 * @return the resulting object list.
	 * @since July, 2011.
	 * @throws ActivitySearchDAOException if an error occurs during the search.
	 */
	public List<Activity> searchActivitiesToDescribe() throws ActivitySearchDAOException;

	/**
	 * Activities to describe search from a parent test case id.
	 * 
	 * @author Clement HELIOU (clement.heliou@che-software.com).
	 * @param testCaseId the parent test case id.
	 * @return the resulting object list.
	 * @since July, 2011.
	 * @throws ActivitySearchDAOException
	 */
	public List<Activity> searchActivitiesToDescribeFromTestCaseId(int testCaseId) throws ActivitySearchDAOException;
}